<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_60) on Sun Dec 20 21:23:26 CET 2015 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Query (gephi 0.9.0 API)</title>
<meta name="date" content="2015-12-20">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="Query (gephi 0.9.0 API)";
        }
    }
    catch(err) {
    }
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!--   -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Query.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/gephi/filters/api/PropertyExecutor.Callback.html" title="interface in org.gephi.filters.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/gephi/filters/api/Range.html" title="class in org.gephi.filters.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/gephi/filters/api/Query.html" target="_top">Frames</a></li>
<li><a href="Query.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.gephi.filters.api</div>
<h2 title="Interface Query" class="title">Interface Query</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Query</span></pre>
<div class="block">Queries are wrapping filters and are assembled in a query tree. Each query is
 built from a single filter instance and it's role is to basically to execute
 the filter. The graph that is passed to the filter depends on the fact the
 query belongs to a complex query tree or if the tree is a single leaf.
 <p>
 The system works like this. Leaves of the query tree receives the complete
 graph and the subgraphs they return are passed to the parent query. Thus the
 root query is the last query to get the subgraphs and returns the final
 result. This querying system make possible to create query chains and complex
 scenario with various operators (AND, OR, ...).
 <p>
 Queries are built by the <code>FilterController</code> from filter instances.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Mathieu Bastian</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/gephi/filters/api/FilterController.html" title="interface in org.gephi.filters.api"><code>FilterController</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../org/gephi/filters/spi/FilterBuilder.html" title="interface in org.gephi.filters.spi">FilterBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/gephi/filters/api/Query.html#getBuilder--">getBuilder</a></span>()</code>
<div class="block">Returns the filter builder that creates the filter this query is
 wrapping.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/gephi/filters/api/Query.html" title="interface in org.gephi.filters.api">Query</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/gephi/filters/api/Query.html#getChildren--">getChildren</a></span>()</code>
<div class="block">Returns queries that are children of this query.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/gephi/filters/api/Query.html#getChildrenSlotsCount--">getChildrenSlotsCount</a></span>()</code>
<div class="block">Returns the limit number of children this query can have.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/gephi/filters/api/Query.html" title="interface in org.gephi.filters.api">Query</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/gephi/filters/api/Query.html#getDescendantsAndSelf--">getDescendantsAndSelf</a></span>()</code>
<div class="block">Utility method that returns all descendant queries plus this query.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../org/gephi/filters/spi/Filter.html" title="interface in org.gephi.filters.spi">Filter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/gephi/filters/api/Query.html#getFilter--">getFilter</a></span>()</code>
<div class="block">Returns the filter this query is wrapping.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/gephi/filters/api/Query.html#getName--">getName</a></span>()</code>
<div class="block">Returns query's full name.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../org/gephi/filters/api/Query.html" title="interface in org.gephi.filters.api">Query</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/gephi/filters/api/Query.html#getParent--">getParent</a></span>()</code>
<div class="block">Returns the parent query or <code>null</code> if this query is root.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/gephi/filters/api/Query.html#getPropertiesCount--">getPropertiesCount</a></span>()</code>
<div class="block">Returns the number of properties this query has.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/gephi/filters/api/Query.html#getPropertyName-int-">getPropertyName</a></span>(int&nbsp;index)</code>
<div class="block">Returns the name of the property at the specified <code>index</code>.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/gephi/filters/api/Query.html#getPropertyValue-int-">getPropertyValue</a></span>(int&nbsp;index)</code>
<div class="block">Returns the value of the property at the specified <code>index</code>.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../org/gephi/filters/api/Query.html" title="interface in org.gephi.filters.api">Query</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/gephi/filters/api/Query.html#getQueries-java.lang.Class-">getQueries</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../org/gephi/filters/spi/Filter.html" title="interface in org.gephi.filters.spi">Filter</a>&gt;&nbsp;filterClass)</code>
<div class="block">Utility method that returns all queries in this query hierarchy that are
 <code>filterClass</code> instance.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="getName--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getName()</pre>
<div class="block">Returns query's full name.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>query's name</dd>
</dl>
</li>
</ul>
<a name="getChildren--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChildren</h4>
<pre><a href="../../../../org/gephi/filters/api/Query.html" title="interface in org.gephi.filters.api">Query</a>[]&nbsp;getChildren()</pre>
<div class="block">Returns queries that are children of this query.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>query's children</dd>
</dl>
</li>
</ul>
<a name="getChildrenSlotsCount--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChildrenSlotsCount</h4>
<pre>int&nbsp;getChildrenSlotsCount()</pre>
<div class="block">Returns the limit number of children this query can have. Return 1 for a
 standard query.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of allowed children query</dd>
</dl>
</li>
</ul>
<a name="getParent--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParent</h4>
<pre><a href="../../../../org/gephi/filters/api/Query.html" title="interface in org.gephi.filters.api">Query</a>&nbsp;getParent()</pre>
<div class="block">Returns the parent query or <code>null</code> if this query is root.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the query's parent query, or <code>null</code></dd>
</dl>
</li>
</ul>
<a name="getPropertiesCount--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPropertiesCount</h4>
<pre>int&nbsp;getPropertiesCount()</pre>
<div class="block">Returns the number of properties this query has.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the query's number of properties</dd>
</dl>
</li>
</ul>
<a name="getPropertyName-int-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPropertyName</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getPropertyName(int&nbsp;index)</pre>
<div class="block">Returns the name of the property at the specified <code>index</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - the index of the property</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the query's property name</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/ArrayIndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">ArrayIndexOutOfBoundsException</a></code> - if <code>index</code> is out of
 bounds</dd>
</dl>
</li>
</ul>
<a name="getPropertyValue-int-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPropertyValue</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;getPropertyValue(int&nbsp;index)</pre>
<div class="block">Returns the value of the property at the specified <code>index</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - the index of the property</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the query's property value</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/ArrayIndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang">ArrayIndexOutOfBoundsException</a></code> - if <code>index</code> is out of
 bounds</dd>
</dl>
</li>
</ul>
<a name="getQueries-java.lang.Class-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueries</h4>
<pre><a href="../../../../org/gephi/filters/api/Query.html" title="interface in org.gephi.filters.api">Query</a>[]&nbsp;getQueries(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../org/gephi/filters/spi/Filter.html" title="interface in org.gephi.filters.spi">Filter</a>&gt;&nbsp;filterClass)</pre>
<div class="block">Utility method that returns all queries in this query hierarchy that are
 <code>filterClass</code> instance.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>filterClass</code> - the filter class that is to be queried</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>all queries, including self that are <code>filterClass</code>
 instance</dd>
</dl>
</li>
</ul>
<a name="getDescendantsAndSelf--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDescendantsAndSelf</h4>
<pre><a href="../../../../org/gephi/filters/api/Query.html" title="interface in org.gephi.filters.api">Query</a>[]&nbsp;getDescendantsAndSelf()</pre>
<div class="block">Utility method that returns all descendant queries plus this query.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>all descendant queries and self</dd>
</dl>
</li>
</ul>
<a name="getFilter--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFilter</h4>
<pre><a href="../../../../org/gephi/filters/spi/Filter.html" title="interface in org.gephi.filters.spi">Filter</a>&nbsp;getFilter()</pre>
<div class="block">Returns the filter this query is wrapping.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the filter</dd>
</dl>
</li>
</ul>
<a name="getBuilder--">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getBuilder</h4>
<pre><a href="../../../../org/gephi/filters/spi/FilterBuilder.html" title="interface in org.gephi.filters.spi">FilterBuilder</a>&nbsp;getBuilder()</pre>
<div class="block">Returns the filter builder that creates the filter this query is
 wrapping.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the builder or null</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!--   -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Query.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/gephi/filters/api/PropertyExecutor.Callback.html" title="interface in org.gephi.filters.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/gephi/filters/api/Range.html" title="class in org.gephi.filters.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/gephi/filters/api/Query.html" target="_top">Frames</a></li>
<li><a href="Query.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007&#x2013;2015 <a href="http://consortium.gephi.org">Gephi Consortium</a>. All rights reserved.</small></p>
</body>
</html>
